home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / X11 / XmbTextPerCharExtents.z / XmbTextPerCharExtents
Encoding:
Text File  |  2002-10-03  |  8.4 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmbbbbTTTTeeeexxxxttttPPPPeeeerrrrCCCChhhhaaaarrrrEEEExxxxtttteeeennnnttttssss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXmmmmbbbbTTTTeeeexxxxttttPPPPeeeerrrrCCCChhhhaaaarrrrEEEExxxxtttteeeennnnttttssss((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XmbTextPerCharExtents, XwcTextPerCharExtents - obtain per-
  10.           character information for a text string
  11.  
  12.      SSSSYYYYNNNNTTTTAAAAXXXX
  13.           Status XmbTextPerCharExtents(_f_o_n_t__s_e_t, _s_t_r_i_n_g, _n_u_m__b_y_t_e_s,
  14.           _i_n_k__a_r_r_a_y__r_e_t_u_r_n,
  15.                      _l_o_g_i_c_a_l__a_r_r_a_y__r_e_t_u_r_n, _a_r_r_a_y__s_i_z_e,
  16.           _n_u_m__c_h_a_r_s__r_e_t_u_r_n, _o_v_e_r_a_l_l__i_n_k__r_e_t_u_r_n,
  17.           _o_v_e_r_a_l_l__l_o_g_i_c_a_l__r_e_t_u_r_n)
  18.                 XFontSet _f_o_n_t__s_e_t;
  19.                 char *_s_t_r_i_n_g;
  20.                 int _n_u_m__b_y_t_e_s;
  21.                 XRectangle *_i_n_k__a_r_r_a_y__r_e_t_u_r_n;
  22.                 XRectangle *_l_o_g_i_c_a_l__a_r_r_a_y__r_e_t_u_r_n;
  23.                 int _a_r_r_a_y__s_i_z_e;
  24.                 int *_n_u_m__c_h_a_r_s__r_e_t_u_r_n;
  25.                 XRectangle *_o_v_e_r_a_l_l__i_n_k__r_e_t_u_r_n;
  26.                 XRectangle *_o_v_e_r_a_l_l__l_o_g_i_c_a_l__r_e_t_u_r_n;
  27.  
  28.           Status XwcTextPerCharExtents(_f_o_n_t__s_e_t, _s_t_r_i_n_g, _n_u_m__w_c_h_a_r_s,
  29.           _i_n_k__a_r_r_a_y__r_e_t_u_r_n,
  30.                     _l_o_g_i_c_a_l__a_r_r_a_y__r_e_t_u_r_n, _a_r_r_a_y__s_i_z_e,
  31.           _n_u_m__c_h_a_r_s__r_e_t_u_r_n, _o_v_e_r_a_l_l__i_n_k__r_e_t_u_r_n,
  32.           _o_v_e_r_a_l_l__l_o_g_i_c_a_l__r_e_t_u_r_n)
  33.                 XFontSet _f_o_n_t__s_e_t;
  34.                 wchar_t *_s_t_r_i_n_g;
  35.                 int _n_u_m__w_c_h_a_r_s;
  36.                 XRectangle *_i_n_k__a_r_r_a_y__r_e_t_u_r_n;
  37.                 XRectangle *_l_o_g_i_c_a_l__a_r_r_a_y__r_e_t_u_r_n;
  38.                 int _a_r_r_a_y__s_i_z_e;
  39.                 int *_n_u_m__c_h_a_r_s__r_e_t_u_r_n;
  40.                 XRectangle *_o_v_e_r_a_l_l__i_n_k__r_e_t_u_r_n;
  41.                 XRectangle *_o_v_e_r_a_l_l__l_o_g_i_c_a_l__r_e_t_u_r_n;
  42.  
  43.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  44.           _a_r_r_a_y__s_i_z_e
  45.                     Specifies the size of ink_array_return and
  46.                     logical_array_return.  The caller must pass in
  47.                     arrays of this size.
  48.  
  49.           _f_o_n_t__s_e_t  Specifies the font set.
  50.  
  51.           _i_n_k__a_r_r_a_y__r_e_t_u_r_n
  52.                     Returns the ink dimensions for each character.
  53.  
  54.           _l_o_g_i_c_a_l__a_r_r_a_y__r_e_t_u_r_n
  55.                     Returns the logical dimensions for each character.
  56.  
  57.           _n_u_m__b_y_t_e_s Specifies the number of bytes in the string
  58.                     argument.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmbbbbTTTTeeeexxxxttttPPPPeeeerrrrCCCChhhhaaaarrrrEEEExxxxtttteeeennnnttttssss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXmmmmbbbbTTTTeeeexxxxttttPPPPeeeerrrrCCCChhhhaaaarrrrEEEExxxxtttteeeennnnttttssss((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           _n_u_m__c_h_a_r_s__r_e_t_u_r_n
  75.                     Returns the number of characters in the string
  76.                     argument.
  77.  
  78.           _n_u_m__w_c_h_a_r_s
  79.                     Specifies the number of characters in the string
  80.                     argument.
  81.  
  82.           _o_v_e_r_a_l_l__i_n_k__r_e_t_u_r_n
  83.                     Returns the overall ink extents of the entire
  84.                     string.
  85.  
  86.           _o_v_e_r_a_l_l__l_o_g_i_c_a_l__r_e_t_u_r_n
  87.                     Returns the overall logical extents of the entire
  88.                     string.
  89.  
  90.           _s_t_r_i_n_g    Specifies the character string.
  91.  
  92.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  93.           The _X_m_b_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s and _X_w_c_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s
  94.           functions return the text dimensions of each character of
  95.           the specified text, using the fonts loaded for the specified
  96.           font set.  Each successive element of ink_array_return and
  97.           logical_array_return is set to the successive character's
  98.           drawn metrics, relative to the drawing origin of the string
  99.           and one rectangle for each character in the supplied text
  100.           string.  The number of elements of ink_array_return and
  101.           logical_array_return that have been set is returned to
  102.           num_chars_return.
  103.  
  104.           Each element of ink_array_return is set to the bounding box
  105.           of the corresponding character's drawn foreground color.
  106.           Each element of logical_array_return is set to the bounding
  107.           box that provides minimum spacing to other graphical
  108.           features for the corresponding character.  Other graphical
  109.           features should not intersect any of the
  110.           logical_array_return rectangles.
  111.  
  112.           Note that an _X_R_e_c_t_a_n_g_l_e represents the effective drawing
  113.           dimensions of the character, regardless of the number of
  114.           font glyphs that are used to draw the character or the
  115.           direction in which the character is drawn.  If multiple
  116.           characters map to a single character glyph, the dimensions
  117.           of all the _X_R_e_c_t_a_n_g_l_e_s of those characters are the same.
  118.  
  119.           When the _X_F_o_n_t_S_e_t has missing charsets, metrics for each
  120.           unavailable character are taken from the default string
  121.           returned by _X_C_r_e_a_t_e_F_o_n_t_S_e_t so that the metrics represent the
  122.           text as it will actually be drawn.  The behavior for an
  123.           invalid codepoint is undefined.
  124.  
  125.           If the array_size is too small for the number of characters
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmbbbbTTTTeeeexxxxttttPPPPeeeerrrrCCCChhhhaaaarrrrEEEExxxxtttteeeennnnttttssss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXmmmmbbbbTTTTeeeexxxxttttPPPPeeeerrrrCCCChhhhaaaarrrrEEEExxxxtttteeeennnnttttssss((((3333XXXX11111111))))
  137.  
  138.  
  139.  
  140.           in the supplied text, the functions return zero and
  141.           num_chars_return is set to the number of rectangles
  142.           required.  Otherwise, the functions return a nonzero value.
  143.  
  144.           If the overall_ink_return or overall_logical_return argument
  145.           is non-NULL, _X_m_b_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s and _X_w_c_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s
  146.           return the maximum extent of the string's metrics to
  147.           overall_ink_return or overall_logical_return, as returned by
  148.           _X_m_b_T_e_x_t_E_x_t_e_n_t_s or _X_w_c_T_e_x_t_E_x_t_e_n_t_s.
  149.  
  150.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  151.           XmbTextEscapement(3X11), XmbTextExtents(3X11) _X_l_i_b - _C
  152.           _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.